<!DOCTYPE HTML>

<html lang="en">
<head>

<title>AnnotationParameterNameDiscoverer (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="AnnotationParameterNameDiscoverer (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":10,"i1":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="AnnotationParameterNameDiscoverer.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="AnnotationParameterNameDiscoverer.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="AnnotationParameterNameDiscoverer.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="AnnotationParameterNameDiscoverer.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="AnnotationParameterNameDiscoverer.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.core.parameters</a></div>
<h2 title="Class AnnotationParameterNameDiscoverer" class="title">Class AnnotationParameterNameDiscoverer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.springframework.security.core.parameters.AnnotationParameterNameDiscoverer</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>org.springframework.core.ParameterNameDiscoverer</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">AnnotationParameterNameDiscoverer</span>
extends java.lang.Object
implements org.springframework.core.ParameterNameDiscoverer</pre>
<div class="block">Allows finding parameter names using the value attribute of any number of
<code>Annotation</code> instances. This is useful when needing to discover the parameter
names of interfaces with Spring Security's method level security. For example, consider
the following:
<pre> import org.springframework.security.access.method.P;

 <code>@PostAuthorize("#to == returnObject.to")</code>
 public Message findMessageByTo(@P("to") String to);
 </pre>
We can make this possible using the following <a href="AnnotationParameterNameDiscoverer.html" title="class in org.springframework.security.core.parameters"><code>AnnotationParameterNameDiscoverer</code></a>
:
<pre> ParameterAnnotationsNameDiscoverer discoverer = new ParameterAnnotationsNameDiscoverer(
                &quot;org.springframework.security.access.method.P&quot;);
 </pre>
<p>
It is common for users to use <a href="AnnotationParameterNameDiscoverer.html" title="class in org.springframework.security.core.parameters"><code>AnnotationParameterNameDiscoverer</code></a> in conjunction
with <code>PrioritizedParameterNameDiscoverer</code>. In fact, Spring Security's
<a href="DefaultSecurityParameterNameDiscoverer.html" title="class in org.springframework.security.core.parameters"><code>DefaultSecurityParameterNameDiscoverer</code></a> (which is used by default with method
level security) extends <code>PrioritizedParameterNameDiscoverer</code> and will
automatically support both <a href="../../access/method/P.html" title="annotation in org.springframework.security.access.method"><code>P</code></a> and Spring Data's Param annotation if it is found
on the classpath.
</p>
<p>
It is important to note that if a single parameter name has a supported annotation on
it then all methods are resolved using <a href="AnnotationParameterNameDiscoverer.html" title="class in org.springframework.security.core.parameters"><code>AnnotationParameterNameDiscoverer</code></a>. For
example, consider the following:
</p>
<pre> import org.springframework.security.access.method.P;

 <code>@PostAuthorize("#to == returnObject.to")</code>
 public Message findMessageByToAndFrom(@P("to") User to, User from);
 </pre>
<p>
The result of finding parameters on the previous sample will be
<code>new String[] { "to", null}</code> since only a single parameter contains an
annotation. This is mostly due to the fact that the fallbacks for
<code>PrioritizedParameterNameDiscoverer</code> are an all or nothing operation.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.2</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="DefaultSecurityParameterNameDiscoverer.html" title="class in org.springframework.security.core.parameters"><code>DefaultSecurityParameterNameDiscoverer</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">

</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="AnnotationParameterNameDiscoverer.html#%3Cinit%3E(java.lang.String...)">AnnotationParameterNameDiscoverer</a></span>&#8203;(java.lang.String...&nbsp;annotationClassToUse)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="AnnotationParameterNameDiscoverer.html#%3Cinit%3E(java.util.Set)">AnnotationParameterNameDiscoverer</a></span>&#8203;(java.util.Set&lt;java.lang.String&gt;&nbsp;annotationClassesToUse)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AnnotationParameterNameDiscoverer.html#getParameterNames(java.lang.reflect.Constructor)">getParameterNames</a></span>&#8203;(java.lang.reflect.Constructor&lt;?&gt;&nbsp;constructor)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AnnotationParameterNameDiscoverer.html#getParameterNames(java.lang.reflect.Method)">getParameterNames</a></span>&#8203;(java.lang.reflect.Method&nbsp;method)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">

</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(java.lang.String...)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>AnnotationParameterNameDiscoverer</h4>
<pre>public&nbsp;AnnotationParameterNameDiscoverer&#8203;(java.lang.String...&nbsp;annotationClassToUse)</pre>
</li>
</ul>
<a id="&lt;init&gt;(java.util.Set)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AnnotationParameterNameDiscoverer</h4>
<pre>public&nbsp;AnnotationParameterNameDiscoverer&#8203;(java.util.Set&lt;java.lang.String&gt;&nbsp;annotationClassesToUse)</pre>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">

</a>
<h3>Method Detail</h3>
<a id="getParameterNames(java.lang.reflect.Method)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameterNames</h4>
<pre class="methodSignature">public&nbsp;java.lang.String[]&nbsp;getParameterNames&#8203;(java.lang.reflect.Method&nbsp;method)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getParameterNames</code>&nbsp;in interface&nbsp;<code>org.springframework.core.ParameterNameDiscoverer</code></dd>
</dl>
</li>
</ul>
<a id="getParameterNames(java.lang.reflect.Constructor)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getParameterNames</h4>
<pre class="methodSignature">public&nbsp;java.lang.String[]&nbsp;getParameterNames&#8203;(java.lang.reflect.Constructor&lt;?&gt;&nbsp;constructor)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getParameterNames</code>&nbsp;in interface&nbsp;<code>org.springframework.core.ParameterNameDiscoverer</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="AnnotationParameterNameDiscoverer.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="AnnotationParameterNameDiscoverer.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="AnnotationParameterNameDiscoverer.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="AnnotationParameterNameDiscoverer.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="AnnotationParameterNameDiscoverer.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040d2b40916980c","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
